feat(cloudflare): add queue and scheduled support WIP #1579

Hebilicious · 2023-08-15T11:05:24Z

🔗 Linked issue

Related #1571

❓ Type of change

📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
🐞 Bug fix (a non-breaking change that fixes an issue)
👌 Enhancement (improving an existing functionality like performance)
✨ New feature (a non-breaking change that adds functionality)
🧹 Chore (updates to the build process or auxiliary tools and libraries)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

📝 Checklist

I have linked an issue or discussion.
I have updated the documentation accordingly.

src/runtime/entries/cloudflare-module.ts

pi0 · 2023-08-15T11:13:17Z

src/runtime/entries/cloudflare-module.ts

+    env: CFModuleEnv,
+    context: ExecutionContext
+  ) {
+    return nitroApp.hooks.callHook("cloudflare:queue", batch, env, context);


To make sure forward/backward compatibility would be nice to send them all as { batch, env, context }

Will try.
My main issue with this is that from what I can see, return nitroApp.hooks.callHook("test", () => 1) doesn't return 1 ?
Is there any other API suggestion here ?

Second arg is passed to listeners it is not a callback.

Right, since we are supposed to return something, should we do something like this ?

const hookResponse = { response: new Response() } await nitroApp.hooks.callHook("cloudflare-module:queue", { batch, env, context, hookResponse }); return hookResponse.response

Ah for handling, yes we might pass a callback like sendResponse (from the context object)

export default defineNitroPlugin((app) => { app.hooks.hook("cloudflare:scheduled", (event) => { event.waitUntil(new Promise((resolve) => resolve("scheduled:cloudflare"))); }); app.hooks.hook( "cloudflare-module:scheduled", ({ controller, env, context }) => { context.waitUntil( new Promise((resolve) => resolve("scheduled:cloudflare-module")) ); } ); app.hooks.hook("cloudflare:queue", (event) => { event.sendResponse = () => "queued:cloudflare"; }); app.hooks.hook("cloudflare-module:queue", ({ batch, env, context }) => { context.sendResponse = () => "queued:cloudflare-module"; }); });

pi0 · 2023-08-15T11:14:07Z

src/runtime/entries/cloudflare.ts

 import { withoutBase } from "ufo";
 import { requestHasBody } from "../utils";
 import { nitroApp } from "#internal/nitro/app";
 import { useRuntimeConfig } from "#internal/nitro";
 import { getPublicAssetMeta } from "#internal/nitro/virtual/public-assets";

+addEventListener("scheduled", (event) => {
+  return nitroApp.hooks.callHook("cloudflare:scheduled", event);


Can you make sure if the format is same or similar to workers?

They have different arguments, but typing doesn't work properly. Should we go with cloudflare-module:scheduled and cloudflare:scheduled instead?

the first event is typed as any

Is the event type also different between them?

Is the event type also different between them?

According to Typescript, they are the same for scheduled. But they aren't for queues.

Edit: Nevermind they are totally different

At least object syntax would make them more similar... This is a low-level hook anyway btw so i won't worry too much about differences. We can set an indicator key like isWorker/isModule if needed.

interface CloudflareModuleRuntimeHooks { "cloudflare:scheduled": (moduleArgs: { controller: ScheduledController; env: CloudflareModuleEnv; context: ExecutionContext; }) => any; "cloudflare:queue": (moduleArgs: { batch: MessageBatch; env: CloudflareModuleEnv; context: ExecutionContext; }) => any; } interface CloudflareSWRuntimeHooks { "cloudflare:scheduled": (event: ScheduledEvent) => any; "cloudflare:queue": (event: QueueEvent) => any; }

This is their signature at the moment, they don't have any common properties.

Note that addEventListener can also accept a 3rd optional argument that could be specified with a 2nd hook.

export interface EventTargetAddEventListenerOptions { capture?: boolean; passive?: boolean; once?: boolean; signal?: AbortSignal; }

trylovetom · 2023-08-29T11:05:11Z

Hello @pi0 @Hebilicious

I noticed that the PR is currently in a draft status. May I ask if there are any follow-up plans or an expected release timeline for this?

I believe it brings tremendous value and can truly elevate the cloudflare project to another level.

pi0 · 2023-08-29T11:31:10Z

@trylovetom Surely it is in the roadmap for next minor version of Nitro. I expect to release alongside new Tasks feature so that you can easily test everything universally before deploying!

trylovetom · 2023-08-30T06:00:23Z

Surely it is in the roadmap for next minor version of Nitro. I expect to release alongside new Tasks feature so that you can easily test everything universally before deploying!

That's fantastic news! Is there an RFC or a trial version I can refer to or test out? Perhaps I can assist or provide some user feedback. I'm eager to see how it integrates to the project.

pi0 · 2023-09-08T10:55:07Z

Hi @Hebilicious and thanks again for this PR. More i think it makes more sense that we introduce this feature on top of (universal) nitro tasks (#1571 (comment)) instead of directly supporting provider-flavored APIs and hooks.

I am thinking of closing this draft to clarify our roadmap but i would happy to have your help to build this feature on top of nitro nitro tasks or revisit if that took longer than expected and you think it is critical to support this feature ahead of the time.

Hebilicious · 2023-09-08T11:34:40Z

@pi0 My personal thoughts is that we need 2 features :

Nitro Tasks (similar to Task scheduling in Laravel)
Nitro Queues (similar to Queues in Laravel)

Should I open 2 issues to track these as a follow-up ?

I do think this is going to be a big chunk of work to make them platform agnostic and to integrate with all providers; while introducing platform specific hooks (maybe under an experimental flag?) is relatively fast and clean.

Regarding whether it's critical or not, personally, if I need this, I would use a custom preset.
I think documenting how to make a custom custom preset to use these 2 features, is cleaner and easier, as there's not a need to learn any extra syntax and to figure out how to do something that is already well explained in the cloudflare docs. But I understand that we shouldn't recommend them either ... though call... Maybe we could add an experimental flag for custom presets ? 🤔

pi0 · 2023-09-08T11:59:50Z

No please wait for me to open RFC/POC for Tasks. We can discuss Queues in the next steps. (could be on top as a module. Not sure if queue can be generic feature easily while tasks can)

I do think this is going to be a big chunk of work to make them platform agnostic and to integrate with all providers

This is all mission of Nitro to do heavy tasks like this. Don't worry we can make it happen!

Regarding whether it's critical or not, personally, if I need this, I would use a custom preset.
I think documenting how to make a custom custom preset to use these 2 features, is cleaner and easier, as there's not a need to learn any extra syntax and to figure out how to do something that is already well explained in the cloudflare docs. But I understand that we shouldn't recommend them either ... though call... Maybe we could add an experimental flag for custom presets

Surely as i mentioned above and in linked issue, the initiatives behind introducing hooks was to speed up introducing it for cloudflare, which took longer than expected with your PR and also tasks is one of my main priorities to deliver ASAP.

Again, i wouldn't recommend using custom presets, for same reasons we don't recommend making a custom Vue setup for Nuxt applications. The job of Nitro, Nuxt and other meta frameworks, is to keep users away from boilerplate and make sure they are using best optimized practices. I made both Nuxt and Nitro fully extendable so we don't "block" users of doing something like this just like you can do today but neither don't advice them to do as is a dangerous territory in regards of promised stability. I hope you understand this concept.

Hebilicious · 2023-09-08T12:18:37Z

No please wait for me to open RFC/POC for Tasks. We can discuss Queues in the next steps. (could be on top as a module. Not sure if queue can be generic feature easily while tasks can)

I do think this is going to be a big chunk of work to make them platform agnostic and to integrate with all providers

This is all mission of Nitro to do heavy tasks like this. Don't worry we can make it happen!

Regarding whether it's critical or not, personally, if I need this, I would use a custom preset.
I think documenting how to make a custom custom preset to use these 2 features, is cleaner and easier, as there's not a need to learn any extra syntax and to figure out how to do something that is already well explained in the cloudflare docs. But I understand that we shouldn't recommend them either ... though call... Maybe we could add an experimental flag for custom presets

Surely as i mentioned above and in linked issue, the initiatives behind introducing hooks was to speed up introducing it for cloudflare, which took longer than expected with your PR and also tasks is one of my main priorities to deliver ASAP.

Again, i wouldn't recommend using custom presets, for same reasons we don't recommend making a custom Vue setup for Nuxt applications. The job of Nitro, Nuxt and other meta frameworks, is to keep users away from boilerplate and make sure they are using best optimized practices. I made both Nuxt and Nitro fully extendable so we don't "block" users of doing something like this just like you can do today but neither don't advice them to do as is a dangerous territory in regards of promised stability. I hope you understand this concept.

I understand this concept, I'm reiterating the custom preset point because this PR was closed.
In that regard, I am happy to move forward and re-open this PR (ie add docs), and get it merged if that implementation is satisfactory; or to drop it entirely if you don't think it's important.

feat(cloudflare): add queue and scheduled support

4613118

Hebilicious changed the title ~~feat(cloudflare): add queue and scheduled support~~ feat(cloudflare): add queue and scheduled support WIP Aug 15, 2023

vercel bot deployed to Preview August 15, 2023 11:06 View deployment

pi0 reviewed Aug 15, 2023

View reviewed changes

src/runtime/entries/cloudflare-module.ts Outdated Show resolved Hide resolved

pi0 reviewed Aug 15, 2023

View reviewed changes

Hebilicious added 3 commits August 15, 2023 19:30

feat: improve typings

aa5b9c3

fix: scheduled types

32ffd79

feat: add sendResponse callback

1448389

vercel bot deployed to Preview August 15, 2023 13:41 View deployment

feat: SW syntax can't return directly

cb095e3

vercel bot deployed to Preview August 15, 2023 14:23 View deployment

Hebilicious added 2 commits August 15, 2023 21:34

docs: add better api docs

210cac1

chore: remove logs

df36d8d

vercel bot deployed to Preview August 15, 2023 14:36 View deployment

test: add cloudflare test

7214a9a

vercel bot deployed to Preview August 27, 2023 05:04 View deployment

pi0 closed this Sep 8, 2023

pi0 deleted the feat/cloudflare-queues-scheduled branch October 28, 2023 23:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cloudflare): add queue and scheduled support WIP #1579

feat(cloudflare): add queue and scheduled support WIP #1579

Hebilicious commented Aug 15, 2023 •

edited

Loading

pi0 Aug 15, 2023 •

edited

Loading

Hebilicious Aug 15, 2023

pi0 Aug 15, 2023

Hebilicious Aug 15, 2023

pi0 Aug 15, 2023

Hebilicious Aug 15, 2023 •

edited

Loading

pi0 Aug 15, 2023

Hebilicious Aug 15, 2023 •

edited

Loading

pi0 Aug 15, 2023

Hebilicious Aug 15, 2023 •

edited

Loading

pi0 Aug 15, 2023

Hebilicious Aug 15, 2023 •

edited

Loading

trylovetom commented Aug 29, 2023

pi0 commented Aug 29, 2023

trylovetom commented Aug 30, 2023

pi0 commented Sep 8, 2023

Hebilicious commented Sep 8, 2023

pi0 commented Sep 8, 2023 •

edited

Loading

Hebilicious commented Sep 8, 2023 •

edited

Loading

feat(cloudflare): add queue and scheduled support WIP #1579

feat(cloudflare): add queue and scheduled support WIP #1579

Conversation

Hebilicious commented Aug 15, 2023 • edited Loading

🔗 Linked issue

❓ Type of change

📚 Description

📝 Checklist

pi0 Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

Hebilicious Aug 15, 2023

Choose a reason for hiding this comment

pi0 Aug 15, 2023

Choose a reason for hiding this comment

Hebilicious Aug 15, 2023

Choose a reason for hiding this comment

pi0 Aug 15, 2023

Choose a reason for hiding this comment

Hebilicious Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

pi0 Aug 15, 2023

Choose a reason for hiding this comment

Hebilicious Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

pi0 Aug 15, 2023

Choose a reason for hiding this comment

Hebilicious Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

pi0 Aug 15, 2023

Choose a reason for hiding this comment

Hebilicious Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

trylovetom commented Aug 29, 2023

pi0 commented Aug 29, 2023

trylovetom commented Aug 30, 2023

pi0 commented Sep 8, 2023

Hebilicious commented Sep 8, 2023

pi0 commented Sep 8, 2023 • edited Loading

Hebilicious commented Sep 8, 2023 • edited Loading

Hebilicious commented Aug 15, 2023 •

edited

Loading

pi0 Aug 15, 2023 •

edited

Loading

Hebilicious Aug 15, 2023 •

edited

Loading

Hebilicious Aug 15, 2023 •

edited

Loading

Hebilicious Aug 15, 2023 •

edited

Loading

Hebilicious Aug 15, 2023 •

edited

Loading

pi0 commented Sep 8, 2023 •

edited

Loading

Hebilicious commented Sep 8, 2023 •

edited

Loading